<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>simplevideomarkdetect: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
<link rel="prev" href="gst-plugins-bad-plugins-shmsrc.html" title="shmsrc">
<link rel="next" href="gst-plugins-bad-plugins-simplevideomark.html" title="simplevideomark">
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-plugins-simplevideomarkdetect.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-plugins-simplevideomarkdetect.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-plugins-simplevideomarkdetect.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-plugins-bad-plugins-shmsrc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-plugins-bad-plugins-simplevideomark.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-bad-plugins-simplevideomarkdetect"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-simplevideomarkdetect.top_of_page"></a>simplevideomarkdetect</span></h2>
<p>simplevideomarkdetect</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-simplevideomarkdetect.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--bottom-offset" title="The “bottom-offset” property">bottom-offset</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--left-offset" title="The “left-offset” property">left-offset</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--message" title="The “message” property">message</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-center" title="The “pattern-center” property">pattern-center</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-count" title="The “pattern-count” property">pattern-count</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-data-count" title="The “pattern-data-count” property">pattern-data-count</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-height" title="The “pattern-height” property">pattern-height</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-sensitivity" title="The “pattern-sensitivity” property">pattern-sensitivity</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-width" title="The “pattern-width” property">pattern-width</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
</tbody>
</table></div>
</div>
<a name="GstSimpleVideoMarkDetect"></a><div class="refsect1">
<a name="gst-plugins-bad-plugins-simplevideomarkdetect.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect-struct" title="struct GstSimpleVideoMarkDetect">GstSimpleVideoMarkDetect</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-simplevideomarkdetect.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
                <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a>
                    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoFilter.html#GstVideoFilter-struct">GstVideoFilter</a>
                        <span class="lineart">╰──</span> GstSimpleVideoMarkDetect
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-simplevideomarkdetect.description"></a><h2>Description</h2>
<p>This plugin detects <a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-count" title="The “pattern-count” property"><span class="type">“pattern-count”</span></a> squares in the bottom left
corner of the video frames. The squares have a width and height of
respectively <a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-width" title="The “pattern-width” property"><span class="type">“pattern-width”</span></a> and <a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-height" title="The “pattern-height” property"><span class="type">“pattern-height”</span></a>.
Even squares must be black and odd squares must be white.</p>
<p>When the pattern has been found, <a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-data-count" title="The “pattern-data-count” property"><span class="type">“pattern-data-count”</span></a> squares
after the pattern squares are read as a bitarray. White squares represent a 1
bit and black squares a 0 bit. The bitarray will will included in the element
message that is posted (see below).</p>
<p>After the pattern has been found and the data pattern has been read, an
element message called <code class="literal">GstSimpleVideoMarkDetect</code> will
be posted on the bus. If the pattern is no longer found in the frame, the
same element message is posted with the have-pattern field set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
The message is only posted if the <a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--message" title="The “message” property"><span class="type">“message”</span></a> property is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p>
<p>The message's structure contains these fields:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a><code class="literal">have-pattern</code>: if the pattern was found. This field will be set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for as long as
the pattern was found in the frame and set to FALSE for the first frame
that does not contain the pattern anymore.</p></li>
<li class="listitem"><p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> <code class="literal">timestamp</code>: the timestamp of the buffer that triggered the message.</p></li>
<li class="listitem"><p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> <code class="literal">stream-time</code>: the stream time of the buffer.</p></li>
<li class="listitem"><p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> <code class="literal">running-time</code>: the running_time of the buffer.</p></li>
<li class="listitem"><p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> <code class="literal">duration</code>: the duration of the buffer.</p></li>
<li class="listitem"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> <code class="literal">data</code>: the data-pattern found after the pattern or 0 when have-signal is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p></li>
</ul></div>
<div class="refsect3">
<a name="id-1.2.198.7.7"></a><h4>Example launch line</h4>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1</pre></td>
        <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> videotestsrc <span class="gtkdoc opt">!</span> simplevideomarkdetect <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> ximagesink</pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
</div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="id-1.2.198.7.8.1"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">plugin</span></p></td>
<td>
            <a class="link" href="gst-plugins-bad-plugins-plugin-videosignal.html#plugin-videosignal">videosignal</a>
          </td>
</tr>
<tr>
<td><p><span class="term">author</span></p></td>
<td>Wim Taymans &lt;wim@fluendo.com&gt;</td>
</tr>
<tr>
<td><p><span class="term">class</span></p></td>
<td>Filter/Effect/Video</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.198.7.8.2"></a><h3>Element Pads</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>video/x-raw, format=(string){ I420, YV12, Y41B, Y42B, Y444, YUY2, UYVY, AYUV, YVYU }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>src</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>source</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>video/x-raw, format=(string){ I420, YV12, Y41B, Y42B, Y444, YUY2, UYVY, AYUV, YVYU }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-simplevideomarkdetect.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-simplevideomarkdetect.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstSimpleVideoMarkDetect-struct"></a><h3>struct GstSimpleVideoMarkDetect</h3>
<pre class="programlisting">struct GstSimpleVideoMarkDetect;</pre>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-simplevideomarkdetect.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstSimpleVideoMarkDetect--bottom-offset"></a><h3>The <code class="literal">“bottom-offset”</code> property</h3>
<pre class="programlisting">  “bottom-offset”            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The offset from the bottom border where the pattern starts.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSimpleVideoMarkDetect--left-offset"></a><h3>The <code class="literal">“left-offset”</code> property</h3>
<pre class="programlisting">  “left-offset”              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The offset from the left border where the pattern starts.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSimpleVideoMarkDetect--message"></a><h3>The <code class="literal">“message”</code> property</h3>
<pre class="programlisting">  “message”                  <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Post detected data as bus messages.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSimpleVideoMarkDetect--pattern-center"></a><h3>The <code class="literal">“pattern-center”</code> property</h3>
<pre class="programlisting">  “pattern-center”           <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>The center of the black/white separation (0.0 = lowest, 1.0 highest).</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0.5</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSimpleVideoMarkDetect--pattern-count"></a><h3>The <code class="literal">“pattern-count”</code> property</h3>
<pre class="programlisting">  “pattern-count”            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The number of pattern markers.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 4</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSimpleVideoMarkDetect--pattern-data-count"></a><h3>The <code class="literal">“pattern-data-count”</code> property</h3>
<pre class="programlisting">  “pattern-data-count”       <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The number of extra data pattern markers.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 5</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSimpleVideoMarkDetect--pattern-height"></a><h3>The <code class="literal">“pattern-height”</code> property</h3>
<pre class="programlisting">  “pattern-height”           <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The height of the pattern markers.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: &gt;= 1</p>
<p>Default value: 16</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSimpleVideoMarkDetect--pattern-sensitivity"></a><h3>The <code class="literal">“pattern-sensitivity”</code> property</h3>
<pre class="programlisting">  “pattern-sensitivity”      <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>The sensitivity around the center for detecting the markers (0.0 = lowest, 1.0 highest).</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0.3</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSimpleVideoMarkDetect--pattern-width"></a><h3>The <code class="literal">“pattern-width”</code> property</h3>
<pre class="programlisting">  “pattern-width”            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The width of the pattern markers.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: &gt;= 1</p>
<p>Default value: 4</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-simplevideomarkdetect.see-also"></a><h2>See Also</h2>
<p><span class="type">GstVideoMark</span></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>